Skip to main content

BILDIT Complete API Collection (Postman Collection)

Complete collection of ALL BILDIT Visual Experience Engine API endpoints including Remote, OCAPI, SiteSpect, DynamicYield, and other services. Based on BILDIT_Complete_API_Collection.postman_collection.json.

Using with Postman​

  1. Import the collection: Import BILDIT_Complete_API_Collection.postman_collection.json into Postman.
  2. Create an environment: Add an environment with these variables:
    • base_url — e.g. https://admin.bildit.co for Production; see Base URLs for Stage/Local
    • api_key — your app key (use your-api-key-here as placeholder; obtain from your Visual Experience Engine app configuration)
  3. Select the environment before running requests.
caution

Never commit or share real API keys. Use placeholders in shared configs and obtain your key from the Visual Experience Engine.

Variables​

  • base_url: Base Firebase Functions host
  • api_key: App key for authentication (use your own — never share)

Remote Endpoints​

v1 Endpoints​

  • GET /v1/remote-banners — list scheduled content by device
  • GET /v1/remote-webbanners — web scheduled content with filters (tomorrow, location, category, customerGroup, date)
  • GET /v1/remote-categories — categories
  • GET /v1/remote-component — component by path, version, platform
  • GET /v1/remote-config — configuration object
  • GET /v1/remote-content — asset by slug or cid
  • GET /v1/remote-baseCodelib — base templates
  • GET /v1/remote-baseComponent — base component
  • GET /v1/remote-screen — specification by name, version, platform
  • GET /v1/remote-notifications — notifications by platform, stores
  • GET /v1/appetizeio-banners — AppetizeIO scheduled content

v1_1 Endpoints​

  • GET /v1_1/remote-banners
  • GET /v1_1/remote-webbanners — adds mode parameter (compiled/transpiled)
  • GET /v1_1/remote-component
  • GET /v1_1/appetizeio-banners

Legacy (No Version Prefix)​

  • GET /remote-banners — list scheduled content by device
  • GET /remote-webbanners — web scheduled content with filters
  • GET /remote-categories — categories
  • GET /remote-component — component by path, version, platform
  • GET /remote-config — configuration object
  • GET /remote-content — asset by slug or cid
  • GET /remote-baseCodelib — base templates
  • GET /remote-baseComponent — base component
  • GET /remote-screen — specification by name, version, platform
  • GET /remote-notifications — notifications by platform, stores
  • GET /appetizeio-banners — AppetizeIO scheduled content

OCAPI Endpoints​

OCAPI (Open Commerce API) endpoints for Salesforce Commerce Cloud integration. All support ALL methods and proxy to the underlying OCAPI services.

Base (No Version Prefix)​

  • ALL /ocapi-account/**
  • ALL /ocapi-bag/**
  • ALL /ocapi-catalog/**
  • ALL /ocapi-checkout/**
  • ALL /ocapi-controller/**

v1 Endpoints​

  • ALL /v1/ocapi-account/**
  • ALL /v1/ocapi-bag/**
  • ALL /v1/ocapi-catalog/**
  • ALL /v1/ocapi-checkout/**
  • ALL /v1/ocapi-controller/**

SiteSpect Engine​

  • ALL /sitespect-engine/**
  • ALL /v1/sitespect-engine/**

DynamicYield Engine​

  • ALL /dynamicyield-engine/**
  • ALL /v1/dynamicyield-engine/**

AI & Content Generation​

  • GET /v1/generateAmpScript
  • GET /v1/updateBrandConfiguration
  • GET /v1/updateContentCreatorConfiguration
  • GET /v1/seedContentCreatorConfiguration
  • GET /v1/getContentCreatorConfigurationEditableValues
  • GET /v1/getContentCreatorConfiguration
  • GET /v1/aiEmailSubjectCreator

Cache & Utility​

  • GET /v1/caches-saveInfo
  • POST /firebase-token
  • GET /config/sso

Example Requests​

Remote Endpoints Example​

curl "{{base_url}}/v1_1/remote-webbanners?key={{api_key}}&mode=compiled&location=home&category=promo&customerGroup=default"